<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Lithne: Message Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Lithne
   &#160;<span id="projectnumber">v0.9</span>
   </div>
   <div id="projectbrief">Lithne Library</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.8.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('class_message.html','');
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">Message Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af1991e0448f9277f0939d142e4aa2c94"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#af1991e0448f9277f0939d142e4aa2c94">Message</a> ()</td></tr>
<tr class="memitem:a39795494fa0850ded8a9845670c71fe7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#a39795494fa0850ded8a9845670c71fe7">clearArguments</a> ()</td></tr>
<tr class="memitem:a6cf7b995c71b56b5ad93edb3cba8f0c9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#a6cf7b995c71b56b5ad93edb3cba8f0c9">setRecipient64</a> (XBeeAddress64 _addr64)</td></tr>
<tr class="memitem:ab9db940064491f9a2d9d09c9a8f1e95d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9db940064491f9a2d9d09c9a8f1e95d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setRecipient16</b> (uint16_t _addr16)</td></tr>
<tr class="memitem:a0b74beb7981b0c79c31c1643cab703bd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#a0b74beb7981b0c79c31c1643cab703bd">setFunction</a> (uint16_t _func)</td></tr>
<tr class="memitem:a4afe772bcd1ad2b31911a6797376eb3c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#a4afe772bcd1ad2b31911a6797376eb3c">setSender64</a> (XBeeAddress64 _addr64)</td></tr>
<tr class="memitem:ab4222a4caeed6f5eacfa4940996e7918"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#ab4222a4caeed6f5eacfa4940996e7918">setSender16</a> (uint16_t _addr16)</td></tr>
<tr class="memitem:a1b59fb8526ffa16c9aa47f5e8a953a8f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#a1b59fb8526ffa16c9aa47f5e8a953a8f">setSender</a> (uint16_t _addr16, XBeeAddress64 _addr64)</td></tr>
<tr class="memitem:a17fb87eca91a2945b13cd0c9ea651aee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#a17fb87eca91a2945b13cd0c9ea651aee">setScope</a> (uint16_t _scope)</td></tr>
<tr class="memitem:a98932f7d2eba2fa6e19f7dd89db3713d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#a98932f7d2eba2fa6e19f7dd89db3713d">addArgument</a> (uint16_t _arg)</td></tr>
<tr class="memitem:aadb53b8c2f789c39bc7d201ed4534e7c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#aadb53b8c2f789c39bc7d201ed4534e7c">getNumberOfArguments</a> ()</td></tr>
<tr class="memitem:a281a2cdfe63729b4d79f02bd9354efcb"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#a281a2cdfe63729b4d79f02bd9354efcb">getArgument</a> (uint8_t _position)</td></tr>
<tr class="memitem:ad0c185e247f59816bfe6eabe01805506"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#ad0c185e247f59816bfe6eabe01805506">getFunction</a> ()</td></tr>
<tr class="memitem:a4adf83103b7030336d7dffe792457bb5"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#a4adf83103b7030336d7dffe792457bb5">getSender16</a> ()</td></tr>
<tr class="memitem:a702a4a84b2e64bb53e81e40b51db6592"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#a702a4a84b2e64bb53e81e40b51db6592">getRecipient16</a> ()</td></tr>
<tr class="memitem:af46fefad0e438edaedd735e1e6ce249c"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#af46fefad0e438edaedd735e1e6ce249c">getScope</a> ()</td></tr>
<tr class="memitem:a655dc1f9216a2fbcab23492bd9d9093b"><td class="memItemLeft" align="right" valign="top">XBeeAddress64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#a655dc1f9216a2fbcab23492bd9d9093b">getSender64</a> ()</td></tr>
<tr class="memitem:ab1d0a28ec1c469ea6af199201505f64d"><td class="memItemLeft" align="right" valign="top">XBeeAddress64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_message.html#ab1d0a28ec1c469ea6af199201505f64d">getRecipient64</a> ()</td></tr>
</table>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af1991e0448f9277f0939d142e4aa2c94"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_message.html">Message</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default <a class="el" href="class_message.html">Message</a> constructor </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a98932f7d2eba2fa6e19f7dd89db3713d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="class_message.html#a98932f7d2eba2fa6e19f7dd89db3713d">addArgument</a> </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>arg</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Add an argument to the list of arguments </p>

</div>
</div>
<a class="anchor" id="a39795494fa0850ded8a9845670c71fe7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_message.html#a39795494fa0850ded8a9845670c71fe7">clearArguments</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Clear all message arguments (set them to 0) </p>

</div>
</div>
<a class="anchor" id="a281a2cdfe63729b4d79f02bd9354efcb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t <a class="el" href="class_message.html#a281a2cdfe63729b4d79f02bd9354efcb">getArgument</a> </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>position</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>return the argument at the specified position </p>

</div>
</div>
<a class="anchor" id="ad0c185e247f59816bfe6eabe01805506"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t <a class="el" href="class_message.html#ad0c185e247f59816bfe6eabe01805506">getFunction</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the function of the message </p>

</div>
</div>
<a class="anchor" id="aadb53b8c2f789c39bc7d201ed4534e7c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t <a class="el" href="class_message.html#aadb53b8c2f789c39bc7d201ed4534e7c">getNumberOfArguments</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the number of arguments </p>

</div>
</div>
<a class="anchor" id="a702a4a84b2e64bb53e81e40b51db6592"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t <a class="el" href="class_message.html#a702a4a84b2e64bb53e81e40b51db6592">getRecipient16</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>return the 16 bit address of the recipient </p>

</div>
</div>
<a class="anchor" id="ab1d0a28ec1c469ea6af199201505f64d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XBeeAddress64 <a class="el" href="class_message.html#ab1d0a28ec1c469ea6af199201505f64d">getRecipient64</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the receiving XBee address </p>

</div>
</div>
<a class="anchor" id="af46fefad0e438edaedd735e1e6ce249c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t <a class="el" href="class_message.html#af46fefad0e438edaedd735e1e6ce249c">getScope</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the scope of the message </p>

</div>
</div>
<a class="anchor" id="a4adf83103b7030336d7dffe792457bb5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t <a class="el" href="class_message.html#a4adf83103b7030336d7dffe792457bb5">getSender16</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the 16 bit address of the sender </p>

</div>
</div>
<a class="anchor" id="a655dc1f9216a2fbcab23492bd9d9093b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XBeeAddress64 <a class="el" href="class_message.html#a655dc1f9216a2fbcab23492bd9d9093b">getSender64</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the transmitting XBee address </p>

</div>
</div>
<a class="anchor" id="a0b74beb7981b0c79c31c1643cab703bd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_message.html#a0b74beb7981b0c79c31c1643cab703bd">setFunction</a> </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>_func</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set the function the message should call </p>

</div>
</div>
<a class="anchor" id="a6cf7b995c71b56b5ad93edb3cba8f0c9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_message.html#a6cf7b995c71b56b5ad93edb3cba8f0c9">setRecipient64</a> </td>
          <td>(</td>
          <td class="paramtype">XBeeAddress64&#160;</td>
          <td class="paramname"><em>_addr64</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set the recipient for the message using 64 bit Address </p>

</div>
</div>
<a class="anchor" id="a17fb87eca91a2945b13cd0c9ea651aee"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_message.html#a17fb87eca91a2945b13cd0c9ea651aee">setScope</a> </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>_scope</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets the scope for this message. </p>

</div>
</div>
<a class="anchor" id="a1b59fb8526ffa16c9aa47f5e8a953a8f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_message.html#a1b59fb8526ffa16c9aa47f5e8a953a8f">setSender</a> </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>_addr16</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XBeeAddress64&#160;</td>
          <td class="paramname"><em>_addr64</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set both the 16-bit and 64-bit address of the sender in one go </p>

</div>
</div>
<a class="anchor" id="ab4222a4caeed6f5eacfa4940996e7918"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_message.html#ab4222a4caeed6f5eacfa4940996e7918">setSender16</a> </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>_addr16</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Store the 16-bit address of the sender </p>

</div>
</div>
<a class="anchor" id="a4afe772bcd1ad2b31911a6797376eb3c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_message.html#a4afe772bcd1ad2b31911a6797376eb3c">setSender64</a> </td>
          <td>(</td>
          <td class="paramtype">XBeeAddress64&#160;</td>
          <td class="paramname"><em>_addr64</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Store the 64 bit address of the sender of the message </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>E:/My Documents/Arduino/libraries/Lithne/<a class="el" href="_message_8h_source.html">Message.h</a></li>
<li>E:/My Documents/Arduino/libraries/Lithne/Message.cpp</li>
</ul>
</div><!-- contents -->
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="class_message.html">Message</a>      </li>

    <li class="footer">Generated on Wed Apr 4 2012 17:22:48 for Lithne by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
   </ul>
 </div>


</body>
</html>
